Get list of businesses

GET /api/v1/businesses

Description

This endpoint allows you to retrieve a list of businesses based on various query parameters. You can filter businesses based on criteria such as date range, KYC status, wallet account, location, address, sources, types, tenant IDs, user IDs, business IDs, search query, distributor status, accepting orders, and active status.

Query Parameters:

• businessDateRange (Optional): Date range for businesses, e.g., "2020-11-12,2022-11-15."
• businessByKycStatus (Optional): KYC status (e.g., "APPROVE").
• businessByWalletAccount (Optional): Wallet account.
• businessByLocations (Optional): Location in the format "longitude,latitude" or "-40.943,29.2933."
• businessAddress (Optional): Business address.
• businessBySources (Optional): Comma-separated values for sources (e.g., "SHOP,TRACE,AGENCY,AGENT,DEAL,OWN,PLATFORM").
• businessByTypes (Optional): Comma-separated values for types (e.g., "SUPPLIER,MERCHANT,AGENCY_BANKING,SABI_AGENT,SABI_OWN").
• businessByTenantIds (Optional): Tenant IDs.
• businessByUserIds (Optional): User IDs.
• businessByIds (Optional): Business IDs.
• businessSearch (Optional): Search query.
• businessByIsDistributor (Optional): 1 for distributor status.
• businessByAcceptingOrder (Optional): 1 for businesses that accept orders.
• businessByActive (Optional): 1 for active businesses.
• order (Optional): Sorting order (e.g., "DESC" for descending).
• page (Optional): Page number.
• limit (Optional): Limit the number of results per page.

Response:

• Status Code: 200 (OK)

/api/v1/businesses?businessDateRange=<string>&businessByKycStatus=APPROVE&businessByWalletAccount=<string>&businessByLocations=<string>&businessAddress=<string>&businessBySources=<string>&businessByTypes=<string>&businessByTenantIds=<string>&businessByUserIds=<string>&businessByIds=<string>&businessSearch=<string>&businessByIsDistributor=1&businessByAcceptingOrder=1&businessByActive=1&order=DESC&page=<string>&limit=<string>

Query Params

Param	value
businessDateRange	string
businessByKycStatus	APPROVE
businessByWalletAccount	string
businessByLocations	string
businessAddress	string
businessBySources	string
businessByTypes	string
businessByTenantIds	string
businessByUserIds	string
businessByIds	string
businessSearch	string
businessByIsDistributor	1
businessByAcceptingOrder	1
businessByActive	1
order	DESC
page	string
limit	string

Response: 200